feat: add HasItem expectation for collections#681
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces a new HasItem expectation for collection verification, allowing users to verify that collections contain elements matching specific criteria at given indices or any index. The implementation includes full support for both generic and non-generic enumerables, including async enumerables, and provides fluent API methods for index targeting.
- Implementation of
HasItemfunctionality for various collection types with predicate and object matching support - Addition of fluent API methods
AtIndex()andAtAnyIndex()for targeted element verification - Comprehensive test coverage across different collection types and scenarios
Reviewed Changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| ThatEnumerable.HasItem.cs | Core implementation of HasItem extension methods for synchronous collections |
| ThatAsyncEnumerable.HasItem.cs | Async enumerable support for HasItem functionality |
| HasItemResult.cs | Result type providing AtIndex/AtAnyIndex fluent methods |
| HasItemObjectResult.cs | Enhanced result type with Equivalent/Using methods for object comparisons |
| CollectionIndexOptions.cs | Index range validation and description logic |
| Various test files | Extensive test coverage for all HasItem scenarios |
Comments suppressed due to low confidence (16)
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.Tests.cs:38
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. Based on the test logic (lines 45-53), this test expects a failure/exception when the predicate doesn't match, so it should be named something like 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.Tests.cs:68
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception (lines 80-88), so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.Tests.cs:195
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception (lines 205-213), so it should be named 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed(
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.Tests.cs:233
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception (lines 245-253), so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed(int expected)
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.ImmutableTests.cs:16
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.ImmutableTests.cs:46
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.ImmutableTests.cs:112
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.ImmutableTests.cs:142
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.EnumerableTests.cs:39
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.EnumerableTests.cs:69
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.EnumerableTests.cs:191
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed(
Tests/aweXpect.Tests/Collections/ThatEnumerable.HasItem.EnumerableTests.cs:231
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed(int expected)
Tests/aweXpect.Tests/Collections/ThatAsyncEnumerable.HasItem.Tests.cs:39
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatAsyncEnumerable.HasItem.Tests.cs:69
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatAsyncEnumerable.HasItem.Tests.cs:190
- The test method name 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsDifferentItemAtGivenIndex_ShouldSucceed()
Tests/aweXpect.Tests/Collections/ThatAsyncEnumerable.HasItem.Tests.cs:220
- The test method name 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed' is misleading. The test expects a failure/exception, so it should be named 'WhenEnumerableContainsNoItemAtGivenIndex_ShouldFail'.
public async Task WhenEnumerableContainsNoItemAtGivenIndex_ShouldSucceed()
## Have item at index
You can verify that the collection contains an item that satisfies the expectation on a given index (or any index).
```csharp
IEnumerable<string> values = ["0th item", "1st item", "2nd item", "3rd item"];
await Expect.That(values).HasItem("1st item").AtIndex(1);
await Expect.That(values).HasItem(a => a.StartsWith("2nd")).AtAnyIndex();
```
*Note: The same expectation works also for `IAsyncEnumerable<T>`.*
vbreuss
force-pushed
the
topic/add-hasitem
branch
from
dc2748d to
15cc4da
Compare
|
Contributor
Contributor
|
This is addressed in release v2.20.0. |
This was referenced Aug 4, 2025
This was referenced Aug 18, 2025
This was referenced Mar 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Have item at index
You can verify that the collection contains an item that satisfies the expectation on a given index (or any index).
Note: The same expectation works also for
IAsyncEnumerable<T>.